<?php
/**     
  *
  * Copyright (c) 2009, Persistent Systems Limited
  *
  * Redistribution and use, with or without modification, are permitted 
  *  provided that the following  conditions are met:
  *   - Redistributions of source code must retain the above copyright notice, 
  *     this list of conditions and the following disclaimer.
  *   - Neither the name of Persistent Systems Limited nor the names of its contributors 
  *     may be used to endorse or promote products derived from this software 
  *     without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
/**
 *  For ACS constants
 */ 
require_once 'ACS/ACSConstants.php';

/**
 *  For set/get Scope properties
 */ 
require_once 'ACS/Scope.php';
/**
 *  For set/get web proxy details
 */ 
require_once 'util/HttpWebProxy.php';

/**
 * Authentication Class
 * @access abstract
 */
abstract  class Authentication
{
   /**
	* @access private
	* @var string
	*/
	private $_acmHostName;

   /**
	* @access private
	* @var string
	*/
    private $_serviceName;

   /**
	* @access private
	* @var string
	*/
    private $_httpWebProxy;

   /**
	* @access private
	* @var string
	*/
    private $_scope;

   /**
	* Sets the member variables
	* @param string $acmHostName It is the ACM host name
	* @param string $serviceName It is the service name.
	*/	
	public function __construct($acmHostName, $serviceName)
    {
	    $this->_acmHostName = $acmHostName;
        $this->_serviceName = $serviceName;
    }
    
	abstract function getACSToken() ;

   /**
	* Sets the proxy object
	* @param object $httpWebProxy It is object of Proxy class
	*/
	public function setHttpWebProxy($httpWebProxy)
    {
        $this->_httpWebProxy = $httpWebProxy;
    }


	/**
	* Gets the proxy object
	* @return object $httpWebProxy It is object of Proxy class
	*/
	public function getHttpWebProxy()
    {
       return $this->_httpWebProxy ;
    }

   /**
	* Sets the scope object
	* @param object $scope It is the object of class scope
	*/
	public function setScope($scope)
    {
        $this->_scope = $scope;
    }

	/**
	* Sets the scope object
	* @return object $scope It is the object of class cope
	*/
	public function getScope()
    {
        return $this->_scope ;
    }
    
 
	/**
	* Sets the AcmHostName
	* @param $acmHostName
	*/
	public function setAcmHostName($acmHostName)
    {
        $this->_acmHostName = $acmHostName;
    }

	/**
	* Gets the scope object
	* @return AcmHostName name
	*/
	public function getAcmHostName()
    {
        return $this->_acmHostName ;
    }
 
	/**
	* Sets the Service Name
	* @param  $serviceName
	*/
	public function setServiceName($serviceName)
    {
        $this->_serviceName = $_serviceName;
    }

	/**
	* Gets the Service Name
	* @return serviceName
	*/
	public function getServiceName()
    {
        return $this->_serviceName ;
    }
}
?>
